Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MU WPCOM: dashboard: add launchpad #41138

Merged
merged 10 commits into from
Jan 29, 2025
Merged

MU WPCOM: dashboard: add launchpad #41138

merged 10 commits into from
Jan 29, 2025

Conversation

ellatrix
Copy link
Contributor

@ellatrix ellatrix commented Jan 16, 2025

Note

It's not really +1000 LoC! That's just the package lock file. 😊

image image

See Automattic/wp-calypso#95386.

Proposed changes:

  • Add the launchpad component as a widget to the dashboard.
  • Minor adjustments to styling so it fits with wp-admin.

See #39806 for some prior work.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • With classic style admin enabled (Settings > General), create a new (unlaunched) site, and test the links in the Dashboard widget.
  • It should not appear for launched sites.
  • Test the links.
  • Test launching a site (make sure to enable read-write)

@ellatrix ellatrix changed the title Add/dashboard launch steps MU WPCOM: dashboard: add launchpad Jan 16, 2025
Copy link
Contributor

github-actions bot commented Jan 16, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.


Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 16, 2025
@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from cae4a82 to 26a557a Compare January 16, 2025 20:49
Copy link
Contributor

github-actions bot commented Jan 16, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/dashboard-launch-steps branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/dashboard-launch-steps
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/dashboard-launch-steps
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from 26a557a to 1a7922f Compare January 22, 2025 14:15
@ellatrix ellatrix marked this pull request as ready for review January 22, 2025 15:05
fallback: {
...jetpackWebpackConfig.resolve.fallback,
events: require.resolve( 'events/' ),
},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've taken these changes from the previous PR: #39806

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is it about?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from 99f805c to b0b8bfd Compare January 23, 2025 16:15
@ellatrix ellatrix added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 23, 2025
@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from b0b8bfd to 97088ad Compare January 23, 2025 16:23
@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from 97088ad to ad0f173 Compare January 27, 2025 13:42
@youknowriad
Copy link
Contributor

A couple things I noticed:

  • When I launch a site, the launch button remains, I actually wonder if we should refresh the page instead of removing the widget (and the button) manually, for maintainability reasons. You mentioned that it's possible to render the "launch confirmation modal" using a query string, maybe we should use that instead.

  • I have an unlaunched site (although I tweaked the options to get into this state) where I site the launchpad but it's totally empty. I wonder how is this possible.

@@ -73,6 +76,8 @@
"@wordpress/url": "4.16.0",
"clsx": "2.1.1",
"debug": "4.4.0",
"events": "^3.3.0",
"i18n-calypso": "7.0.0",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is interesting, we have some components that use this, and others that use @wordpress/i18n. What's the story there? Maybe @jsnajdr knows. How to decide what to use...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I think ideally we should switch to @wordpress/i18n. But I don't want to trigger string changes for this PR. Also, there's some use cases that can't be easily done with @wordpress/i18n such as strings with HTML elements inside of them (I think).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, there's some use cases that can't be easily done with @wordpress/i18n such as strings with HTML elements inside of them (I think).

I think we have createInterpolateElement for that use-case. So I think we're covered there.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, looking a that, it does work a bit differently, and the strings would still have to change. I guess that could be fine.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may be wrong, but I don't think that translation strings using i18n-calypso's translate() function would even be picked up, only the @wordpress/i18n-style __(), _x(), and so on.

We've generally avoided @automattic/components for similar reasons. It has (or has had in the past, anyway) a lot of stuff that's specific to Calypso that doesn't work so well in Jetpack.

@ellatrix
Copy link
Contributor Author

Thanks, I'll investigate! Sure, the query string might be ok in this case. I guess it's fine to reload for this action.

@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from 3fd191d to 3469f65 Compare January 28, 2025 13:38
@ellatrix
Copy link
Contributor Author

A couple things I noticed:

  • When I launch a site, the launch button remains, I actually wonder if we should refresh the page instead of removing the widget (and the button) manually, for maintainability reasons. You mentioned that it's possible to render the "launch confirmation modal" using a query string, maybe we should use that instead.
  • I have an unlaunched site (although I tweaked the options to get into this state) where I site the launchpad but it's totally empty. I wonder how is this possible.

Both addressed :)

@youknowriad
Copy link
Contributor

jetpack-downloader doesn't seem to work for me at the moment.

@youknowriad
Copy link
Contributor

I still see the empty widget, I don't know if it's jetpack downloader not working properly or if the fix didn't work properly

@youknowriad
Copy link
Contributor

So it's definitely jetpack downloader (I don't know why yet)

*
* @return {Function} A ref callback.
*/
function useSetHrefBase() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this weird hook

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So currently some of the links in Launchpad are relative. These are supposed to be wordpress.com links, so we need to adjust the base. There other wp-admin links are absolute and they are correct.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we instead have a prop for the component instead (maybe as a follow-up) to make the component calypso agnostic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can try!

youknowriad
youknowriad previously approved these changes Jan 28, 2025
Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The duplication is not ideal, but it should be ok for now.

@ellatrix ellatrix force-pushed the add/dashboard-launch-steps branch from fe094a0 to c88dcb0 Compare January 28, 2025 16:08
Copy link
Contributor

Code Coverage Summary

Coverage changed in 2 files.

File Coverage Δ% Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/features/wpcom-dashboard-widgets/wpcom-dashboard-widgets.php 0/71 (0.00%) 0.00% 17 💔
projects/plugins/jetpack/extensions/store/membership-products/resolvers.js 56/106 (52.83%) 0.94% -1 💚

Full summary · PHP report · JS report

@ellatrix
Copy link
Contributor Author

Let's do it :)

@ellatrix ellatrix merged commit 923e295 into trunk Jan 29, 2025
80 checks passed
@ellatrix ellatrix deleted the add/dashboard-launch-steps branch January 29, 2025 15:50
@github-actions github-actions bot removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Status] In Progress labels Jan 29, 2025
ellatrix added a commit that referenced this pull request Jan 29, 2025
@@ -9284,6 +9494,10 @@ packages:
[email protected]:
resolution: {integrity: sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==}

[email protected]:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ellatrix added a commit that referenced this pull request Jan 30, 2025
ellatrix added a commit that referenced this pull request Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants